Document GtkTextSearchFlags

Move the doc about the flags from gtk_text_iter_forward_search() to the
enum.

https://bugzilla.gnome.org/show_bug.cgi?id=390048

diff --git a/gtk/gtktextiter.c b/gtk/gtktextiter.c
index 474cfe595349af248fb5126d735c47df1a3dc0bf..84a0ec8336169be080692ef33e357c3dbdeefe17 100644 (file)
--- a/gtk/gtktextiter.c
+++ b/gtk/gtktextiter.c
@@ -4858,18 +4858,8 @@ strbreakup (const char *string,
  * @limit. Note that a search is a linear or O(n) operation, so you
  * may wish to use @limit to avoid locking up your UI on large
  * buffers.
- * 
- * If the #GTK_TEXT_SEARCH_VISIBLE_ONLY flag is present, the match may
- * have invisible text interspersed in @str. i.e. @str will be a
- * possibly-noncontiguous subsequence of the matched range. similarly,
- * if you specify #GTK_TEXT_SEARCH_TEXT_ONLY, the match may have
- * pixbufs or child widgets mixed inside the matched range. If these
- * flags are not given, the match must be exact; the special 0xFFFC
- * character in @str will match embedded pixbufs or child widgets.
- * If you specify the #GTK_TEXT_SEARCH_CASE_INSENSITIVE flag, the text will
- * be matched regardless of what case it is in.
  *
- * Return value: whether a match was found
+ * Returns: whether a match was found
  **/
 gboolean
 gtk_text_iter_forward_search (const GtkTextIter *iter,

diff --git a/gtk/gtktextiter.h b/gtk/gtktextiter.h
index 830d28e14ab2631a531ab6ffd8bf6b752776982e..57ce274f8edcccbd134490211990f995a4c11a26 100644 (file)
--- a/gtk/gtktextiter.h
+++ b/gtk/gtktextiter.h
@@ -35,6 +35,21 @@
 
 G_BEGIN_DECLS
 
+/**
+ * GtkTextSearchFlags:
+ * @GTK_TEXT_SEARCH_VISIBLE_ONLY: Search only visible data. A search match may
+ * have invisible text interspersed.
+ * @GTK_TEXT_SEARCH_TEXT_ONLY: Search only text. A match may have pixbufs or
+ * child widgets mixed inside the matched range.
+ * @GTK_TEXT_SEARCH_CASE_INSENSITIVE: The text will be matched regardless of
+ * what case it is in.
+ *
+ * Flags affecting how a search is done.
+ *
+ * If neither #GTK_TEXT_SEARCH_VISIBLE_ONLY nor #GTK_TEXT_SEARCH_TEXT_ONLY are
+ * enabled, the match must be exact; the special 0xFFFC character will match
+ * embedded pixbufs or child widgets.
+ */
 typedef enum {
   GTK_TEXT_SEARCH_VISIBLE_ONLY     = 1 << 0,
   GTK_TEXT_SEARCH_TEXT_ONLY        = 1 << 1,